4.5 查询本地用户角色列表
基本信息
Path：/api/v1/directory/queryEntity
Method： POST
接口描述：
- 用户目录ID，本地用户目录固定为"1"
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 必须 |
Body
| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| userDirectoryId | string | 是 | '1' | 本地用户目录ID，必须传'1'才能查询本地用户角色 | |
| include | object[] | 必须 | 查询条件 | ||
| ├─ band | object | 必须 | 用户的查询条件 | ||
| ├─├─pageSize | number | 非必须 | 20 | 分页大小，每页查询的最大数据量，越大查询时间越长，范围是0-5000 | |
| ├─├─pageIndex | number | 非必须 | 1 | 页码，范围是0-10000000 | |
| searchData | string[] | 非必须 | 查询条件：模糊搜索关键字，仅支持搜索单个值，传入多个值时仅首个值生效 |
请求示例
{
"userDirectoryId": "1",
"include": {
"band": {
"pageIndex": 1,
"pageSize": 2
}
},
"searchData": ["111111"]
}
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | number | 必须 | 返回码，0 返回成功 | ||
| data | object | 必须 | 报文数据主体 | ||
| ├─ band | object | 必须 | 数据主体 | ||
| ├─├─ count | number | 必须 | 查询结果的数据总数 | ||
| ├─├─ pageCount | number | 必须 | 查询结果的数据总页数 | ||
| ├─├─ pageSize | number | 必须 | 页大小，每页的最大数据数 | ||
| ├─├─ pageIndex | number | 必须 | 页码 | ||
| ├─├─ data | object[] | 必须 | 查询结果数据主体 | ||
| ├─├─├─ id | string | 必须 | 角色ID | ||
| ├─├─├─ serverName | string | 必须 | 所属用户目录 | ||
| ├─├─├─ name | string | 必须 | 名称 | ||
| ├─├─├─ description | string | 必须 | 描述 | ||
| msg | string | 必须 | 返回提示信息，与返回码对应 |
返回示例
{
"code": 0,
"data": {
"band": {
"count": 1,
"pageCount": 1,
"pageSize": 2,
"pageIndex": 1,
"data": [
{
"id": "87c11940-e402-11ed-8403-7b24bc672fc7",
"name": "111111",
"description": "",
"serverName": "本地用户目录"
}
]
}
},
"msg": "请求成功",
"traceId": "01a9037d03d3a39f"
}
错误信息
| 错误提示 | 错误码 |
|---|---|
| 参数检查出错 | 10000001 |
| 用户目录不存在 | 77200001 |